home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / ac6_093.zip / SRDOOR.DOC < prev    next >
Text File  |  1991-06-13  |  6KB  |  118 lines
  1. ───[SRDOOR 2.1]───────────────────────────────────────────────────────────────
  2.  
  3. Purpose:
  4.          This program reads a BBS door file and converts it into a standard
  5.          Solar Realms format file called DOORFILE.SR.  This one program will
  6.          work with SRE, SCE, AC6, LEA, PC, and any other games from the
  7.          Solar Realm.  The purpose of an external door conversion is to
  8.          allow sysops of BBSes not supported by SRDOOR to use another program
  9.          to convert to the DOORFILE.SR file.  For example, if you were
  10.          running a BBS that produced USER.DAT as a door file, and SRDOOR
  11.          did not support it, you could write a program to replace SRDOOR
  12.          that would read USER.DAT and convert it to DOORFILE.SR.  See the
  13.          section, "File Format".
  14.  
  15. Format:
  16.          SRDOOR [specialbbstype [comport]]
  17.  
  18.          The parameters "specialbbstype" and "comport" are required for
  19.          certain BBS types.  See the "File Format" section for more
  20.          information.
  21.  
  22.          or
  23.  
  24.          SRDOOR COMMAND "<username>" <comport> <baudrate> [params...]
  25.             params: /TIMELIMIT=<minutes>
  26.                     /PAGELEN=<screen rows>
  27.                     /IBMCH=<flag>
  28.                     /ANSI=<flag>
  29.             flag = 1 or 0 (ON or OFF)
  30.  
  31.          This is for other BBS types that are not directly supported.  The
  32.          batch file can pass parameters to SRDOOR to create a doorfile.
  33.          NOTE:  <username> is in quotes (to allow spaces)
  34.  
  35. Setup:
  36.          Use the SRINSTAL/ACINSTAL/PCINSTAL/etc. program to set up a batch
  37.          file.  It will automatically run SRDOOR.
  38.  
  39.          If you have a non-supported BBS, these are some options:
  40.             1.  Use a doorfile converter to convert to a supported format
  41.                 (DOOR.SYS or DORINFO1.DEF preferred)
  42.             2.  Write a program to read your doorfile and write DOORFILE.SR;
  43.                 if you do this, please send us your program so that we may
  44.                 incorporate it into future versions of SRDOOR. (see below)
  45.             3.  Use command-line parameters to pass information to SRDOOR,
  46.                 which will create DOORFILE.SR.
  47.  
  48. Compatibility:
  49.          We have tested SRDOOR with DOOR.SYS and DORINFO1.DEF; we have not
  50.          been able to test it with the other door types.  If you have any
  51.          useful information, please send it to us!
  52.  
  53. File Format:
  54.          SRDOOR reads text files in which one piece of information is on
  55.          each line.  Unfortunately, some BBS programs do not create these
  56.          types of door files.  For standard door files, view SETUP.SR for
  57.          more information.  For a non-standard door file, SRDOOR currently
  58.          has experimental GTUSER and PCBOARD/Searchlight modes:
  59.  
  60.             SRDOOR PCBOARD1
  61.                Converts PCBoard 14.x type PCBOARD.SYS files to DOORFILE.SR.
  62.             SRDOOR PCBOARD2 «comport»
  63.                Converts PCBoard 12.1 type PCBOARD.SYS files to DOORFILE.SR.
  64.             SRDOOR GTUSER «comport»
  65.                Converts GT type GTUSER.BBS files to DOORFILE.SR.
  66.  
  67.          Notice that the parameter «comport» is needed in the Old PC-Board
  68.          and GT-USER files.  Use the COM port that the modem is attached to
  69.          (1, 2, 3, or 4).
  70.  
  71.          You can also write your own program to convert your favorite door
  72.          file to DOORFILE.SR.  The DOORFILE.SR format is:
  73.  
  74.             <line 1):   Complete name of user
  75.             (line 2):   ANSI status:  1 = yes, 0 = no, -1 = don't know
  76.             (line 3):   IBM Graphic characters:  1 = yes, 0 = no, -1 = unknown
  77.             (line 4):   Page length of screen, in lines.  Assume 25 if unknown
  78.             (line 5):   Baud Rate:  300, 1200, 2400, 9600, 19200, etc.
  79.             (line 6):   Com Port:  1, 2, 3, or 4.
  80.             (line 7):   Time Limit:  (in minutes); -1 if unknown.
  81.  
  82. Bugs:
  83.          <> Not tested for BBS types other than DOOR.SYS and DORINFO1.DEF.
  84.  
  85.          <> Baud rates are <unsigned integer> type, so they go only to 65535.
  86.  
  87.          <> PCBOARD 14.x support not working.
  88.  
  89. Online Game Writers:
  90.          We at the Solar Realm encourage you to use this door file format.
  91.          We feel it has all the necessary information for a door game.  It
  92.          also has the advantage of being easy to read in a variety of
  93.          languages (unlike many door files being used that require BASIC,
  94.          Pascal, or C).  By using an external door conversion program, you
  95.          leave open the option for sysops to write their own converter so that
  96.          those sysops who have BBSes that your game does not support may be
  97.          able to find or write a replacement for SRDOOR.
  98.  
  99. Contact:
  100.          For more information, contact the Solar Realm BBS at (713)855-1665.
  101.          (2400 baud.)
  102.  
  103. Disclaimer:
  104.          This program is not guaranteed to work.  It is distributed "as-is".
  105.          If you find it useful, great!  If not, we are in no way to be held
  106.          responsible.  No contribution is required to use this program.  It
  107.          is meant to be used with Solar Realms door programs.
  108.  
  109. Usage:
  110.          If any person wishes to use this program for any other legal use,
  111.          the only requirement is that he or she write a letter to the Solar
  112.          Realm BBS informing them that SRDOOR is being used.  Please describe
  113.          your project.  We are interested in keeping track of all persons
  114.          using SRDOOR (for upgrade notices and information purposes).  No
  115.          charge is required to use SRDOOR, and no fee may be charged for its
  116.          distribution.  This documentation file must accompany SRDOOR.
  117.  
  118.